home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1998 November / Freeware November 1998.img / dist / fw_emacs.idb / usr / freeware / info / gnus-6.z / gnus-6 (.txt)
GNU Info File  |  1998-10-27  |  50KB  |  982 lines

  1. This is Info file ../info/gnus, produced by Makeinfo-1.63 from the
  2. input file gnus.texi.
  3.    This file documents Gnus, the GNU Emacs newsreader.
  4.    Copyright (C) 1995,96 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the entire resulting derived work is distributed under the terms
  11. of a permission notice identical to this one.
  12.    Permission is granted to copy and distribute translations of this
  13. manual into another language, under the above conditions for modified
  14. versions.
  15. File: gnus,  Node: SOUP Groups,  Next: SOUP Replies,  Prev: SOUP Commands,  Up: SOUP
  16. SOUP Groups
  17. ...........
  18.    `nnsoup' is the backend for reading SOUP packets.  It will read
  19. incoming packets, unpack them, and put them in a directory where you
  20. can read them at leisure.
  21.    These are the variables you can use to customize its behavior:
  22. `nnsoup-tmp-directory'
  23.      When `nnsoup' unpacks a SOUP packet, it does it in this directory.
  24.      (`/tmp/' by default.)
  25. `nnsoup-directory'
  26.      `nnsoup' then moves each message and index file to this directory.
  27.      The default is `~/SOUP/'.
  28. `nnsoup-replies-directory'
  29.      All replies will stored in this directory before being packed into
  30.      a reply packet.  The default is `~/SOUP/replies/"'.
  31. `nnsoup-replies-format-type'
  32.      The SOUP format of the replies packets.  The default is `?n'
  33.      (rnews), and I don't think you should touch that variable.  I
  34.      probably shouldn't even have documented it.  Drats!  Too late!
  35. `nnsoup-replies-index-type'
  36.      The index type of the replies packet.  The is `?n', which means
  37.      "none".  Don't fiddle with this one either!
  38. `nnsoup-active-file'
  39.      Where `nnsoup' stores lots of information.  This is not an "active
  40.      file" in the `nntp' sense; it's an Emacs Lisp file.  If you lose
  41.      this file or mess it up in any way, you're dead.  The default is
  42.      `~/SOUP/active'.
  43. `nnsoup-packer'
  44.      Format string command for packing a reply SOUP packet.  The default
  45.      is `tar cf - %s | gzip > $HOME/Soupin%d.tgz'.
  46. `nnsoup-unpacker'
  47.      Format string command for unpacking incoming SOUP packets.  The
  48.      default is `gunzip -c %s | tar xvf -'.
  49. `nnsoup-packet-directory'
  50.      Where `nnsoup' will look for incoming packets.  The default is
  51.      `~/'.
  52. `nnsoup-packet-regexp'
  53.      Regular expression matching incoming SOUP packets.  The default is
  54.      `Soupout'.
  55. File: gnus,  Node: SOUP Replies,  Prev: SOUP Groups,  Up: SOUP
  56. SOUP Replies
  57. ............
  58.    Just using `nnsoup' won't mean that your postings and mailings end
  59. up in SOUP reply packets automagically.  You have to work a bit more
  60. for that to happen.
  61.    The `nnsoup-set-variables' command will set the appropriate
  62. variables to ensure that all your followups and replies end up in the
  63. SOUP system.
  64.    In specific, this is what it does:
  65.      (setq gnus-inews-article-function 'nnsoup-request-post)
  66.      (setq send-mail-function 'nnsoup-request-mail)
  67.    And that's it, really.  If you only want news to go into the SOUP
  68. system you just use the first line.  If you only want mail to be SOUPed
  69. you use the second.
  70. File: gnus,  Node: Combined Groups,  Prev: Other Sources,  Up: Select Methods
  71. Combined Groups
  72. ===============
  73.    Gnus allows combining a mixture of all the other group types into
  74. bigger groups.
  75. * Menu:
  76. * Virtual Groups::     Combining articles from many groups.
  77. * Kibozed Groups::     Looking through parts of the newsfeed for articles.
  78. File: gnus,  Node: Virtual Groups,  Next: Kibozed Groups,  Up: Combined Groups
  79. Virtual Groups
  80. --------------
  81.    An "nnvirtual group" is really nothing more than a collection of
  82. other groups.
  83.    For instance, if you are tired of reading many small group, you can
  84. put them all in one big group, and then grow tired of reading one big,
  85. unwieldy group.  The joys of computing!
  86.    You specify `nnvirtual' as the method.  The address should be a
  87. regexp to match component groups.
  88.    All marks in the virtual group will stick to the articles in the
  89. component groups.  So if you tick an article in a virtual group, the
  90. article will also be ticked in the component group from whence it came.
  91. (And vice versa--marks from the component groups will also be shown in
  92. the virtual group.)
  93.    Here's an example `nnvirtual' method that collects all Andrea Dworkin
  94. newsgroups into one, big, happy newsgroup:
  95.      (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
  96.    The component groups can be native or foreign; everything should work
  97. smoothly, but if your computer explodes, it was probably my fault.
  98.    Collecting the same group from several servers might actually be a
  99. good idea if users have set the Distribution header to limit
  100. distribution.  If you would like to read `soc.motss' both from a server
  101. in Japan and a server in Norway, you could use the following as the
  102. group regexp:
  103.      "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
  104.    This should work kinda smoothly--all articles from both groups should
  105. end up in this one, and there should be no duplicates.  Threading (and
  106. the rest) will still work as usual, but there might be problems with the
  107. sequence of articles.  Sorting on date might be an option here (*note
  108. Selecting a Group::..
  109.    One limitation, however--all groups that are included in a virtual
  110. group has to be alive (i.e., subscribed or unsubscribed).  Killed or
  111. zombie groups can't be component groups for `nnvirtual' groups.
  112.    If the `nnvirtual-always-rescan' is non-`nil', `nnvirtual' will
  113. always scan groups for unread articles when entering a virtual group.
  114. If this variable is `nil' (which is the default) and you read articles
  115. in a component group after the virtual group has been activated, the
  116. read articles from the component group will show up when you enter the
  117. virtual group.  You'll also see this effect if you have two virtual
  118. groups that contain the same component group.  If that's the case, you
  119. should set this variable to `t'.  Or you can just tap `M-g' on the
  120. virtual group every time before you enter it--it'll have much the same
  121. effect.
  122. File: gnus,  Node: Kibozed Groups,  Prev: Virtual Groups,  Up: Combined Groups
  123. Kibozed Groups
  124. --------------
  125.    "Kibozing" is defined by OED as "grepping through (parts of) the
  126. news feed".  `nnkiboze' is a backend that will do this for you.  Oh
  127. joy!  Now you can grind any NNTP server down to a halt with useless
  128. requests!  Oh happiness!
  129.    To create a kibozed group, use the `G k' command in the group buffer.
  130.    The address field of the `nnkiboze' method is, as with `nnvirtual',
  131. a regexp to match groups to be "included" in the `nnkiboze' group.
  132. There most similarities between `nnkiboze' and `nnvirtual' ends.
  133.    In addition to this regexp detailing component groups, an `nnkiboze'
  134. group must have a score file to say what articles that are to be
  135. included in the group (*note Scoring::.).
  136.    You must run `M-x nnkiboze-generate-groups' after creating the
  137. `nnkiboze' groups you want to have.  This command will take time.  Lots
  138. of time.  Oodles and oodles of time.  Gnus has to fetch the headers from
  139. all the articles in all the components groups and run them through the
  140. scoring process to determine if there are any articles in the groups
  141. that are to be part of the `nnkiboze' groups.
  142.    Please limit the number of component groups by using restrictive
  143. regexps.  Otherwise your sysadmin may become annoyed with you, and the
  144. NNTP site may throw you off and never let you back in again.  Stranger
  145. things have happened.
  146.    `nnkiboze' component groups do not have to be alive--they can be
  147. dead, and they can be foreign.  No restrictions.
  148.    The generation of an `nnkiboze' group means writing two files in
  149. `nnkiboze-directory', which is `~/News/' by default.  One contains the
  150. NOV header lines for all the articles in the group, and the other is an
  151. additional `.newsrc' file to store information on what groups that have
  152. been searched through to find component articles.
  153.    Articles that are marked as read in the `nnkiboze' group will have
  154. their NOV lines removed from the NOV file.
  155. File: gnus,  Node: Scoring,  Next: Various,  Prev: Select Methods,  Up: Top
  156. Scoring
  157. *******
  158.    Other people use "kill files", but we here at Gnus Towers like
  159. scoring better than killing, so we'd rather switch than fight.  They do
  160. something completely different as well, so sit up straight and pay
  161. attention!
  162.    All articles have a default score (`gnus-summary-default-score'),
  163. which is 0 by default.  This score may be raised or lowered either
  164. interactively or by score files.  Articles that have a score lower than
  165. `gnus-summary-mark-below' are marked as read.
  166.    Gnus will read any "score files" that apply to the current group
  167. before generating the summary buffer.
  168.    There are several commands in the summary buffer that insert score
  169. entries based on the current article.  You can, for instance, ask Gnus
  170. to lower or increase the score of all articles with a certain subject.
  171.    There are two sorts of scoring entries: Permanent and temporary.
  172. Temporary score entries are self-expiring entries.  Any entries that are
  173. temporary and have not been used for, say, a week, will be removed
  174. silently to help keep the sizes of the score files down.
  175. * Menu:
  176. * Summary Score Commands::   Adding score entries for the current group.
  177. * Group Score Commands::     General score commands.
  178. * Score Variables::          Customize your scoring.  (My, what terminology).
  179. * Score File Format::        What a score file may contain.
  180. * Score File Editing::       You can edit score files by hand as well.
  181. * Adaptive Scoring::         Big Sister Gnus *knows* what you read.
  182. * Followups To Yourself::    Having Gnus notice when people answer you.
  183. * Scoring Tips::             How to score effectively.
  184. * Reverse Scoring::          That problem child of old is not problem.
  185. * Global Score Files::       Earth-spanning, ear-splitting score files.
  186. * Kill Files::               They are still here, but they can be ignored.
  187. * GroupLens::                Getting predictions on what you like to read.
  188. File: gnus,  Node: Summary Score Commands,  Next: Group Score Commands,  Up: Scoring
  189. Summary Score Commands
  190. ======================
  191.    The score commands that alter score entries do not actually modify
  192. real score files.  That would be too inefficient.  Gnus maintains a
  193. cache of previously loaded score files, one of which is considered the
  194. "current score file alist".  The score commands simply insert entries
  195. into this list, and upon group exit, this list is saved.
  196.    The current score file is by default the group's local score file,
  197. even if no such score file actually exists.  To insert score commands
  198. into some other score file (eg. `all.SCORE'), you must first make this
  199. score file the current one.
  200.    General score commands that don't actually change the score file:
  201. `V s'
  202.      Set the score of the current article (`gnus-summary-set-score').
  203. `V S'
  204.      Display the score of the current article
  205.      (`gnus-summary-current-score').
  206. `V t'
  207.      Display all score rules that have been used on the current article
  208.      (`gnus-score-find-trace').
  209. `V R'
  210.      Run the current summary through the scoring process
  211.      (`gnus-summary-rescore').  This might be useful if you're playing
  212.      around with your score files behind Gnus' back and want to see the
  213.      effect you're having.
  214. `V a'
  215.      Add a new score entry, and allow specifying all elements
  216.      (`gnus-summary-score-entry').
  217. `V c'
  218.      Make a different score file the current
  219.      (`gnus-score-change-score-file').
  220. `V e'
  221.      Edit the current score file (`gnus-score-edit-current-scores').
  222.      You will be popped into a `gnus-score-mode' buffer (*note Score
  223.      File Editing::.).
  224. `V f'
  225.      Edit a score file and make this score file the current one
  226.      (`gnus-score-edit-file').
  227. `V F'
  228.      Flush the score cahe (`gnus-score-flush-cache').  This is useful
  229.      after editing score files.
  230. `V C'
  231.      Customize a score file in a visually pleasing manner
  232.      (`gnus-score-customize').
  233. `I C-i'
  234.      Increase the score of the current article
  235.      (`gnus-summary-raise-score').
  236. `L C-l'
  237.      Lower the score of the current article
  238.      (`gnus-summary-lower-score').
  239.    The rest of these commands modify the local score file.
  240. `V m'
  241.      Prompt for a score, and mark all articles with a score below this
  242.      as read (`gnus-score-set-mark-below').
  243. `V E'
  244.      Expunge all articles with a score below the default score (or the
  245.      numeric prefix) (`gnus-score-set-expunge-below').
  246.    The keystrokes for actually making score entries follow a very
  247. regular pattern, so there's no need to list all the commands.
  248. (Hundreds of them.)
  249.   1. The first key is either `I' (upper case i) for increasing the score
  250.      or `L' for lowering the score.
  251.   2. The second key says what header you want to score on.  The
  252.      following keys are available:
  253.     `a'
  254.           Score on the author name.
  255.     `s'
  256.           Score on the subject line.
  257.     `x'
  258.           Score on the Xref line--i.e., the cross-posting line.
  259.     `t'
  260.           Score on thread--the References line.
  261.     `d'
  262.           Score on the date.
  263.     `l'
  264.           Score on the number of lines.
  265.     `i'
  266.           Score on the Message-ID.
  267.     `f'
  268.           Score on followups.
  269.     `b'
  270.           Score on the body.
  271.     `h'
  272.           Score on the head.
  273.   3. The third key is the match type.  Which match types are legal
  274.      depends on what headers you are scoring on.
  275.     `strings'
  276.          `e'
  277.                Exact matching.
  278.          `s'
  279.                Substring matching.
  280.          `f'
  281.                Fuzzy matching.
  282.          `r'
  283.                Regexp matching
  284.     `date'
  285.          `b'
  286.                Before date.
  287.          `a'
  288.                At date.
  289.          `n'
  290.                This date.
  291.     `number'
  292.          `<'
  293.                Less than number.
  294.          `='
  295.                Equal to number.
  296.          `>'
  297.                Greater than number.
  298.   4. The fourth and final key says whether this is a temporary (i.e.,
  299.      expiring) score entry, or a permanent (i.e., non-expiring) score
  300.      entry, or whether it is to be done immediately, without adding to
  301.      the score file.
  302.     `t'
  303.           Temporary score entry.
  304.     `p'
  305.           Permanent score entry.
  306.     `i'
  307.           Immediately scoring.
  308.    So, let's say you want to increase the score on the current author
  309. with exact matching permanently: `I a e p'.  If you want to lower the
  310. score based on the subject line, using substring matching, and make a
  311. temporary score entry: `L s s t'.  Pretty easy.
  312.    To make things a bit more complicated, there are shortcuts.  If you
  313. use a capital letter on either the second or third keys, Gnus will use
  314. defaults for the remaining one or two keystrokes.  The defaults are
  315. "substring" and "temporary".  So `I A' is the same as `I a s t', and `I
  316. a R' is the same as `I a r t'.
  317.    The `gnus-score-mimic-keymap' says whether these commands will
  318. pretend they are keymaps or not.
  319. File: gnus,  Node: Group Score Commands,  Next: Score Variables,  Prev: Summary Score Commands,  Up: Scoring
  320. Group Score Commands
  321. ====================
  322.    There aren't many of these as yet, I'm afraid.
  323. `W f'
  324.      Gnus maintains a cache of score alists to avoid having to reload
  325.      them all the time.  This command will flush the cache
  326.      (`gnus-score-flush-cache').
  327. File: gnus,  Node: Score Variables,  Next: Score File Format,  Prev: Group Score Commands,  Up: Scoring
  328. Score Variables
  329. ===============
  330. `gnus-use-scoring'
  331.      If `nil', Gnus will not check for score files, and will not, in
  332.      general, do any score-related work.  This is `t' by default.
  333. `gnus-kill-killed'
  334.      If this variable is `nil', Gnus will never apply score files to
  335.      articles that have already been through the kill process.  While
  336.      this may save you lots of time, it also means that if you apply a
  337.      kill file to a group, and then change the kill file and want to
  338.      run it over you group again to kill more articles, it won't work.
  339.      You have to set this variable to `t' to do that.  (It is `t' by
  340.      default.)
  341. `gnus-kill-files-directory'
  342.      All kill and score files will be stored in this directory, which is
  343.      initialized from the `SAVEDIR' environment variable by default.
  344.      This is `~/News/' by default.
  345. `gnus-score-file-suffix'
  346.      Suffix to add to the group name to arrive at the score file name
  347.      (`SCORE' by default.)
  348. `gnus-score-uncacheable-files'
  349.      All score files are normally cached to avoid excessive re-loading
  350.      of score files.  However, if this might make you Emacs grow big and
  351.      bloated, so this regexp can be used to weed out score files that
  352.      are unlikely to be needed again.  It would be a bad idea to deny
  353.      caching of `all.SCORE', while it might be a good idea to not cache
  354.      `comp.infosystems.www.authoring.misc.ADAPT'.  In fact, this
  355.      variable is `ADAPT$' by default, so no adaptive score files will
  356.      be cached.
  357. `gnus-save-score'
  358.      If you have really complicated score files, and do lots of batch
  359.      scoring, then you might set this variable to `t'.  This will make
  360.      Gnus save the scores into the `.newsrc.eld' file.
  361. `gnus-score-interactive-default-score'
  362.      Score used by all the interactive raise/lower commands to
  363.      raise/lower score with.  Default is 1000, which may seem
  364.      excessive, but this is to ensure that the adaptive scoring scheme
  365.      gets enough room to play with.  We don't want the small changes
  366.      from the adaptive scoring to overwrite manually entered data.
  367. `gnus-summary-default-score'
  368.      Default score of an article, which is 0 by default.
  369. `gnus-score-over-mark'
  370.      Mark (in the third column) used for articles with a score over the
  371.      default.  Default is `+'.
  372. `gnus-score-below-mark'
  373.      Mark (in the third column) used for articles with a score below the
  374.      default.  Default is `-'.
  375. `gnus-score-find-score-files-function'
  376.      Function used to find score files for the current group.  This
  377.      function is called with the name of the group as the argument.
  378.      Predefined functions available are:
  379.     `gnus-score-find-single'
  380.           Only apply the group's own score file.
  381.     `gnus-score-find-bnews'
  382.           Apply all score files that match, using bnews syntax.  This
  383.           is the default.  For instance, if the current group is
  384.           `gnu.emacs.gnus', `all.emacs.all.SCORE', `not.alt.all.SCORE'
  385.           and `gnu.all.SCORE' would all apply.  In short, the instances
  386.           of `all' in the score file names are translated into `.*', and
  387.           then a regexp match is done.
  388.           This means that if you have some score entries that you want
  389.           to apply to all groups, then you put those entries in the
  390.           `all.SCORE' file.
  391.     `gnus-score-find-hierarchical'
  392.           Apply all score files from all the parent groups.  This means
  393.           that you can't have score files like `all.SCORE' or
  394.           `all.emacs.SCORE', but you can have `SCORE',  `comp.SCORE' and
  395.           `comp.emacs.SCORE'.
  396.      This variable can also be a list of functions.  In that case, all
  397.      these functions will be called, and all the returned lists of
  398.      score files will be applied.  These functions can also return
  399.      lists of score alists directly.  In that case, the functions that
  400.      return these non-file score alists should probably be placed
  401.      before the "real" score file functions, to ensure that the last
  402.      score file returned is the local score file.  Phu.
  403. `gnus-score-expiry-days'
  404.      This variable says how many days should pass before an unused
  405.      score file entry is expired.  If this variable is `nil', no score
  406.      file entries are expired.  It's 7 by default.
  407. `gnus-update-score-entry-dates'
  408.      If this variable is non-`nil', matching score entries will have
  409.      their dates updated.  (This is how Gnus controls expiry--all
  410.      non-matching entries will become too old while matching entries
  411.      will stay fresh and young.)  However, if you set this variable to
  412.      `nil', even matching entries will grow old and will have to face
  413.      that oh-so grim reaper.
  414. `gnus-score-after-write-file-function'
  415.      Function called with the name of the score file just written.
  416. File: gnus,  Node: Score File Format,  Next: Score File Editing,  Prev: Score Variables,  Up: Scoring
  417. Score File Format
  418. =================
  419.    A score file is an `emacs-lisp' file that normally contains just a
  420. single form.  Casual users are not expected to edit these files;
  421. everything can be changed from the summary buffer.
  422.    Anyway, if you'd like to dig into it yourself, here's an example:
  423.      (("from"
  424.        ("Lars Ingebrigtsen" -10000)
  425.        ("Per Abrahamsen")
  426.        ("larsi\\|lmi" -50000 nil R))
  427.       ("subject"
  428.        ("Ding is Badd" nil 728373))
  429.       ("xref"
  430.        ("alt.politics" -1000 728372 s))
  431.       ("lines"
  432.        (2 -100 nil <))
  433.       (mark 0)
  434.       (expunge -1000)
  435.       (mark-and-expunge -10)
  436.       (read-only nil)
  437.       (orphan -10)
  438.       (adapt t)
  439.       (files "/hom/larsi/News/gnu.SCORE")
  440.       (exclude-files "all.SCORE")
  441.       (local (gnus-newsgroup-auto-expire t)
  442.              (gnus-summary-make-false-root 'empty))
  443.       (eval (ding)))
  444.    This example demonstrates absolutely everything about a score file.
  445.    Even though this looks much like lisp code, nothing here is actually
  446. `eval'ed.  The lisp reader is used to read this form, though, so it has
  447. to be legal syntactically, if not semantically.
  448.    Six keys are supported by this alist:
  449. `STRING'
  450.      If the key is a string, it is the name of the header to perform the
  451.      match on.  Scoring can only be performed on these eight headers:
  452.      `From', `Subject', `References', `Message-ID', `Xref', `Lines',
  453.      `Chars' and `Date'.  In addition to these headers, there are three
  454.      strings to tell Gnus to fetch the entire article and do the match
  455.      on larger parts of the article: `Body' will perform the match on
  456.      the body of the article, `Head' will perform the match on the head
  457.      of the article, and `All' will perform the match on the entire
  458.      article.  Note that using any of these last three keys will slow
  459.      down group entry *considerably*.  The final "header" you can score
  460.      on is `Followup'.  These score entries will result in new score
  461.      entries being added for all follow-ups to articles that matches
  462.      these score entries.
  463.      Following this key is a arbitrary number of score entries, where
  464.      each score entry has one to four elements.
  465.        1. The first element is the "match element".  On most headers
  466.           this will be a string, but on the Lines and Chars headers,
  467.           this must be an integer.
  468.        2. If the second element is present, it should be a number--the
  469.           "score element".  This number should be an integer in the
  470.           neginf to posinf interval.  This number is added to the score
  471.           of the article if the match is successful.  If this element
  472.           is not present, the `gnus-score-interactive-default-score'
  473.           number will be used instead.  This is 1000 by default.
  474.        3. If the third element is present, it should be a number--the
  475.           "date element".  This date says when the last time this score
  476.           entry matched, which provides a mechanism for expiring the
  477.           score entries.  It this element is not present, the score
  478.           entry is permanent.  The date is represented by the number of
  479.           days since December 31, 1 ce.
  480.        4. If the fourth element is present, it should be a symbol--the
  481.           "type element".  This element specifies what function should
  482.           be used to see whether this score entry matches the article.
  483.           What match types that can be used depends on what header you
  484.           wish to perform the match on.
  485.          "From, Subject, References, Xref, Message-ID"
  486.                For most header types, there are the `r' and `R'
  487.                (regexp) as well as `s' and `S' (substring) types and
  488.                `e' and `E' (exact match) types.  If this element is not
  489.                present, Gnus will assume that substring matching should
  490.                be used.  `R' and `S' differ from the other two in that
  491.                the matches will be done in a case-sensitive manner.
  492.                All these one-letter types are really just abbreviations
  493.                for the `regexp', `string' and `exact' types, which you
  494.                can use instead, if you feel like.
  495.          "Lines, Chars"
  496.                These two headers use different match types: `<', `>',
  497.                `=', `>=' and `<='.
  498.          "Date"
  499.                For the Date header we have three match types: `before',
  500.                `at' and `after'.  I can't really imagine this ever
  501.                being useful, but, like, it would feel kinda silly not
  502.                to provide this function.  Just in case.  You never
  503.                know.  Better safe than sorry.  Once burnt, twice shy.
  504.                Don't judge a book by its cover.  Never not have sex on
  505.                a first date.
  506.          "Head, Body, All"
  507.                These three match keys use the same match types as the
  508.                `From' (etc) header uses.
  509.          "Followup"
  510.                This match key will add a score entry on all articles
  511.                that followup to some author.  Uses the same match types
  512.                as the `From' header uses.
  513.          "Thread"
  514.                This match key will add a score entry on all articles
  515.                that are part of a thread.  Uses the same match types as
  516.                the `References' header uses.
  517. `mark'
  518.      The value of this entry should be a number.  Any articles with a
  519.      score lower than this number will be marked as read.
  520. `expunge'
  521.      The value of this entry should be a number.  Any articles with a
  522.      score lower than this number will be removed from the summary
  523.      buffer.
  524. `mark-and-expunge'
  525.      The value of this entry should be a number.  Any articles with a
  526.      score lower than this number will be marked as read and removed
  527.      from the summary buffer.
  528. `thread-mark-and-expunge'
  529.      The value of this entry should be a number.  All articles that
  530.      belong to a thread that has a total score below this number will
  531.      be marked as read and removed from the summary buffer.
  532.      `gnus-thread-score-function' says how to compute the total score
  533.      for a thread.
  534. `files'
  535.      The value of this entry should be any number of file names.  These
  536.      files are assumed to be score files as well, and will be loaded
  537.      the same way this one was.
  538. `exclude-files'
  539.      The clue of this entry should be any number of files.  This files
  540.      will not be loaded, even though they would normally be so, for
  541.      some reason or other.
  542. `eval'
  543.      The value of this entry will be `eval'el.  This element will be
  544.      ignored when handling global score files.
  545. `read-only'
  546.      Read-only score files will not be updated or saved.  Global score
  547.      files should feature this atom (*note Global Score Files::.).
  548. `orphan'
  549.      The value of this entry should be a number.  Articles that do not
  550.      have parents will get this number added to their scores.  Imagine
  551.      you follow some high-volume newsgroup, like `comp.lang.c'.  Most
  552.      likely you will only follow a few of the threads, also want to see
  553.      any new threads.
  554.      You can do this with the following two score file entries:
  555.               (orphan -500)
  556.               (mark-and-expunge -100)
  557.      When you enter the group the first time, you will only see the new
  558.      threads.  You then raise the score of the threads that you find
  559.      interesting (with `I T' or `I S'), and ignore (`C y') the rest.
  560.      Next time you enter the group, you will see new articles in the
  561.      interesting threads, plus any new threads.
  562.      I.e. - the orphan score atom is for high-volume groups where there
  563.      exist a few interesting threads which can't be found automatically
  564.      by ordinary scoring rules.
  565. `adapt'
  566.      This entry controls the adaptive scoring.  If it is `t', the
  567.      default adaptive scoring rules will be used.  If it is `ignore', no
  568.      adaptive scoring will be performed on this group.  If it is a
  569.      list, this list will be used as the adaptive scoring rules.  If it
  570.      isn't present, or is something other than `t' or `ignore', the
  571.      default adaptive scoring rules will be used.  If you want to use
  572.      adaptive scoring on most groups, you'd set
  573.      `gnus-use-adaptive-scoring' to `t', and insert an `(adapt ignore)'
  574.      in the groups where you do not want adaptive scoring.  If you only
  575.      want adaptive scoring in a few groups, you'd set
  576.      `gnus-use-adaptive-scoring' to `nil', and insert `(adapt t)' in
  577.      the score files of the groups where you want it.
  578. `adapt-file'
  579.      All adaptive score entries will go to the file named by this
  580.      entry.  It will also be applied when entering the group.  This
  581.      atom might be handy if you want to adapt on several groups at
  582.      once, using the same adaptive file for a number of groups.
  583. `local'
  584.      The value of this entry should be a list of `(VAR VALUE)' pairs.
  585.      Each VAR will be made buffer-local to the current summary buffer,
  586.      and set to the value specified.  This is a convenient, if somewhat
  587.      strange, way of setting variables in some groups if you don't like
  588.      hooks much.
  589. File: gnus,  Node: Score File Editing,  Next: Adaptive Scoring,  Prev: Score File Format,  Up: Scoring
  590. Score File Editing
  591. ==================
  592.    You normally enter all scoring commands from the summary buffer, but
  593. you might feel the urge to edit them by hand as well, so we've supplied
  594. you with a mode for that.
  595.    It's simply a slightly customized `emacs-lisp' mode, with these
  596. additional commands:
  597. `C-c C-c'
  598.      Save the changes you have made and return to the summary buffer
  599.      (`gnus-score-edit-done').
  600. `C-c C-d'
  601.      Insert the current date in numerical format
  602.      (`gnus-score-edit-insert-date').  This is really the day number, if
  603.      you were wondering.
  604. `C-c C-p'
  605.      The adaptive score files are saved in an unformatted fashion.  If
  606.      you intend to read one of these files, you want to "pretty print"
  607.      it first.  This command (`gnus-score-pretty-print') does that for
  608.      you.
  609.    Type `M-x gnus-score-mode' to use this mode.
  610.    `gnus-score-menu-hook' is run in score mode buffers.
  611.    In the summary buffer you can use commands like `V f' and `V e' to
  612. begin editing score files.
  613. File: gnus,  Node: Adaptive Scoring,  Next: Followups To Yourself,  Prev: Score File Editing,  Up: Scoring
  614. Adaptive Scoring
  615. ================
  616.    If all this scoring is getting you down, Gnus has a way of making it
  617. all happen automatically--as if by magic.  Or rather, as if by
  618. artificial stupidity, to be precise.
  619.    When you read an article, or mark an article as read, or kill an
  620. article, you leave marks behind.  On exit from the group, Gnus can sniff
  621. these marks and add score elements depending on what marks it finds.
  622. You turn on this ability by setting `gnus-use-adaptive-scoring' to `t'.
  623.    To give you complete control over the scoring process, you can
  624. customize the `gnus-default-adaptive-score-alist' variable.  For
  625. instance, it might look something like this:
  626.      (defvar gnus-default-adaptive-score-alist
  627.        '((gnus-unread-mark)
  628.          (gnus-ticked-mark (from 4))
  629.          (gnus-dormant-mark (from 5))
  630.          (gnus-del-mark (from -4) (subject -1))
  631.          (gnus-read-mark (from 4) (subject 2))
  632.          (gnus-expirable-mark (from -1) (subject -1))
  633.          (gnus-killed-mark (from -1) (subject -3))
  634.          (gnus-kill-file-mark)
  635.          (gnus-ancient-mark)
  636.          (gnus-low-score-mark)
  637.          (gnus-catchup-mark (from -1) (subject -1))))
  638.    As you see, each element in this alist has a mark as a key (either a
  639. variable name or a "real" mark--a character).  Following this key is a
  640. arbitrary number of header/score pairs.  If there are no header/score
  641. pairs following the key, no adaptive scoring will be done on articles
  642. that have that key as the article mark.  For instance, articles with
  643. `gnus-unread-mark' in the example above will not get adaptive score
  644. entries.
  645.    Each article can have only one mark, so just a single of these rules
  646. will be applied to each article.
  647.    To take `gnus-del-mark' as an example--this alist says that all
  648. articles that have that mark (i.e., are marked with `D') will have a
  649. score entry added to lower based on the `From' header by -4, and
  650. lowered by `Subject' by -1.  Change this to fit your prejudices.
  651.    If you have marked 10 articles with the same subject with
  652. `gnus-del-mark', the rule for that mark will be applied ten times.
  653. That means that that subject will get a score of ten times -1, which
  654. should be, unless I'm much mistaken, -10.
  655.    The headers you can score on are `from', `subject', `message-id',
  656. `references', `xref', `lines', `chars' and `date'.  In addition, you
  657. can score on `followup', which will create an adaptive score entry that
  658. matches on the `References' header using the `Message-ID' of the
  659. current article, thereby matching the following thread.
  660.    You can also score on `thread', which will try to score all articles
  661. that appear in a thread.  `thread' matches uses a `Message-ID' to match
  662. on the `References' header of the article.  If the match is made, the
  663. `Message-ID' of the article is added to the `thread' rule.  (Think
  664. about it.  I'd recommend two aspirins afterwards.)
  665.    If you use this scheme, you should set the score file atom `mark' to
  666. something small--like -300, perhaps, to avoid having small random
  667. changes result in articles getting marked as read.
  668.    After using adaptive scoring for a week or so, Gnus should start to
  669. become properly trained and enhance the authors you like best, and kill
  670. the authors you like least, without you having to say so explicitly.
  671.    You can control what groups the adaptive scoring is to be performed
  672. on by using the score files (*note Score File Format::.).  This will
  673. also let you use different rules in different groups.
  674.    The adaptive score entries will be put into a file where the name is
  675. the group name with `gnus-adaptive-file-suffix' appended.  The default
  676. is `ADAPT'.
  677.    When doing adaptive scoring, substring or fuzzy matching would
  678. probably give you the best results in most cases.  However, if the
  679. header one matches is short, the possibility for false positives is
  680. great, so if the length of the match is less than
  681. `gnus-score-exact-adapt-limit', exact matching will be used.  If this
  682. variable is `nil', exact matching will always be used to avoid this
  683. problem.
  684. File: gnus,  Node: Followups To Yourself,  Next: Scoring Tips,  Prev: Adaptive Scoring,  Up: Scoring
  685. Followups To Yourself
  686. =====================
  687.    Gnus offers two commands for picking out the `Message-ID' header in
  688. the current buffer.  Gnus will then add a score rule that scores using
  689. this `Message-ID' on the `References' header of other articles.  This
  690. will, in effect, increase the score of all articles that respond to the
  691. article in the current buffer.  Quite useful if you want to easily note
  692. when people answer what you've said.
  693. `gnus-score-followup-article'
  694.      This will add a score to articles that directly follow up your own
  695.      article.
  696. `gnus-score-followup-thread'
  697.      This will add a score to all articles that appear in a thread
  698.      "below" your own article.
  699.    These two functions are both primarily meant to be used in hooks like
  700. `gnus-inews-article-hook'.
  701. File: gnus,  Node: Scoring Tips,  Next: Reverse Scoring,  Prev: Followups To Yourself,  Up: Scoring
  702. Scoring Tips
  703. ============
  704. "Crossposts"
  705.      If you want to lower the score of crossposts, the line to match on
  706.      is the `Xref' header.
  707.           ("xref" (" talk.politics.misc:" -1000))
  708. "Multiple crossposts"
  709.      If you want to lower the score of articles that have been
  710.      crossposted to more than, say, 3 groups:
  711.           ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
  712. "Matching on the body"
  713.      This is generally not a very good idea--it takes a very long time.
  714.      Gnus actually has to fetch each individual article from the
  715.      server.  But you might want to anyway, I guess.  Even though there
  716.      are three match keys (`Head', `Body' and `All'), you should choose
  717.      one and stick with it in each score file.  If you use any two,
  718.      each article will be fetched *twice*.  If you want to match a bit
  719.      on the `Head' and a bit on the `Body', just use `All' for all the
  720.      matches.
  721. "Marking as read"
  722.      You will probably want to mark articles that has a score below a
  723.      certain number as read.  This is most easily achieved by putting
  724.      the following in your `all.SCORE' file:
  725.           ((mark -100))
  726.      You may also consider doing something similar with `expunge'.
  727. "Negated character classes"
  728.      If you say stuff like `[^abcd]*', you may get unexpected results.
  729.      That will match newlines, which might lead to, well, The Unknown.
  730.      Say `[^abcd\n]*' instead.
  731. File: gnus,  Node: Reverse Scoring,  Next: Global Score Files,  Prev: Scoring Tips,  Up: Scoring
  732. Reverse Scoring
  733. ===============
  734.    If you want to keep just articles that have `Sex with Emacs' in the
  735. subject header, and expunge all other articles, you could put something
  736. like this in your score file:
  737.      (("subject"
  738.        ("Sex with Emacs" 2))
  739.       (mark 1)
  740.       (expunge 1))
  741.    So, you raise all articles that match `Sex with Emacs' and mark the
  742. rest as read, and expunge them to boot.
  743. File: gnus,  Node: Global Score Files,  Next: Kill Files,  Prev: Reverse Scoring,  Up: Scoring
  744. Global Score Files
  745. ==================
  746.    Sure, other newsreaders have "global kill files".  These are usually
  747. nothing more than a single kill file that applies to all groups, stored
  748. in the user's home directory.  Bah!  Puny, weak newsreaders!
  749.    What I'm talking about here are Global Score Files.  Score files from
  750. all over the world, from users everywhere, uniting all nations in one
  751. big, happy score file union!  Ange-score!  New and untested!
  752.    All you have to do to use other people's score files is to set the
  753. `gnus-global-score-files' variable.  One entry for each score file, or
  754. each score file directory.  Gnus will decide by itself what score files
  755. are applicable to which group.
  756.    Say you want to use all score files in the
  757. `/ftp@ftp.some-where:/pub/score' directory and the single score file
  758. `/ftp@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE':
  759.      (setq gnus-global-score-files
  760.            '("/ftp@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
  761.              "/ftp@ftp.some-where:/pub/score/"))
  762.    Simple, eh?  Directory names must end with a `/'.  These directories
  763. are typically scanned only once during each Gnus session.  If you feel
  764. the need to manually re-scan the remote directories, you can use the
  765. `gnus-score-search-global-directories' command.
  766.    Note that, at present, using this option will slow down group entry
  767. somewhat.  (That is--a lot.)
  768.    If you want to start maintaining score files for other people to use,
  769. just put your score file up for anonymous ftp and announce it to the
  770. world.  Become a retro-moderator!  Participate in the retro-moderator
  771. wars sure to ensue, where retro-moderators battle it out for the
  772. sympathy of the people, luring them to use their score files on false
  773. premises!  Yay!  The net is saved!
  774.    Here are some tips for the would-be retro-moderator, off the top of
  775. my head:
  776.    * Articles that are heavily crossposted are probably junk.
  777.    * To lower a single inappropriate article, lower by `Message-ID'.
  778.    * Particularly brilliant authors can be raised on a permanent basis.
  779.    * Authors that repeatedly post off-charter for the group can safely
  780.      be lowered out of existence.
  781.    * Set the `mark' and `expunge' atoms to obliterate the nastiest
  782.      articles completely.
  783.    * Use expiring score entries to keep the size of the file down.  You
  784.      should probably have a long expiry period, though, as some sites
  785.      keep old articles for a long time.
  786.    ... I wonder whether other newsreaders will support global score
  787. files in the future.  *Snicker*.  Yup, any day now, newsreaders like
  788. Blue Wave, xrn and 1stReader are bound to implement scoring.  Should we
  789. start holding our breath yet?
  790. File: gnus,  Node: Kill Files,  Next: GroupLens,  Prev: Global Score Files,  Up: Scoring
  791. Kill Files
  792. ==========
  793.    Gnus still supports those pesky old kill files.  In fact, the kill
  794. file entries can now be expiring, which is something I wrote before
  795. Daniel Quinlan thought of doing score files, so I've left the code in
  796. there.
  797.    In short, kill processing is a lot slower (and I do mean *a lot*)
  798. than score processing, so it might be a good idea to rewrite your kill
  799. files into score files.
  800.    Anyway, a kill file is a normal `emacs-lisp' file.  You can put any
  801. forms into this file, which means that you can use kill files as some
  802. sort of primitive hook function to be run on group entry, even though
  803. that isn't a very good idea.
  804.    XCNormal kill files look like this:
  805.      (gnus-kill "From" "Lars Ingebrigtsen")
  806.      (gnus-kill "Subject" "ding")
  807.      (gnus-expunge "X")
  808.    This will mark every article written by me as read, and remove them
  809. from the summary buffer.  Very useful, you'll agree.
  810.    Other programs use a totally different kill file syntax.  If Gnus
  811. encounters what looks like a `rn' kill file, it will take a stab at
  812. interpreting it.
  813.    Two summary functions for editing a GNUS kill file:
  814. `M-k'
  815.      Edit this group's kill file (`gnus-summary-edit-local-kill').
  816. `M-K'
  817.      Edit the general kill file (`gnus-summary-edit-global-kill').
  818.    Two group mode functions for editing the kill files:
  819. `M-k'
  820.      Edit this group's kill file (`gnus-group-edit-local-kill').
  821. `M-K'
  822.      Edit the general kill file (`gnus-group-edit-global-kill').
  823.    Kill file variables:
  824. `gnus-kill-file-name'
  825.      A kill file for the group `soc.motss' is normally called
  826.      `soc.motss.KILL'.  The suffix appended to the group name to get
  827.      this file name is detailed by the `gnus-kill-file-name' variable.
  828.      The "global" kill file (not in the score file sense of "global", of
  829.      course) is called just `KILL'.
  830. `gnus-kill-save-kill-file'
  831.      If this variable is non-`nil', Gnus will save the kill file after
  832.      processing, which is necessary if you use expiring kills.
  833. `gnus-apply-kill-hook'
  834.      A hook called to apply kill files to a group.  It is
  835.      `(gnus-apply-kill-file)' by default.  If you want to ignore the
  836.      kill file if you have a score file for the same group, you can set
  837.      this hook to `(gnus-apply-kill-file-unless-scored)'.  If you don't
  838.      want kill files to be processed, you should set this variable to
  839.      `nil'.
  840. `gnus-kill-file-mode-hook'
  841.      A hook called in kill-file mode buffers.
  842. File: gnus,  Node: GroupLens,  Prev: Kill Files,  Up: Scoring
  843. GroupLens
  844. =========
  845.    GroupLens is a collaborative filtering system that helps you work
  846. together with other people to find the quality news articles out of the
  847. huge volume of news articles generated every day.
  848.    To accomplish this the GroupLens system combines your opinions about
  849. articles you have already read with the opinions of others who have done
  850. likewise and gives you a personalized prediction for each unread news
  851. article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
  852. rate articles, and finds other people that rate articles the same way.
  853. Once it has found for you some people you agree with it tells you, in
  854. the form of a prediction, what they thought of the article.  You can use
  855. this prediction to help you decide whether or not you want to read the
  856. article.
  857. * Menu:
  858. * Using GroupLens::          How to make Gnus use GroupLens.
  859. * Rating Articles::          Letting GroupLens know how you rate articles.
  860. * Displaying Predictions::   Displaying predictions given by GroupLens.
  861. * GroupLens Variables::      Customizing GroupLens.
  862. File: gnus,  Node: Using GroupLens,  Next: Rating Articles,  Up: GroupLens
  863. Using GroupLens
  864. ---------------
  865.    To use GroupLens you must register a pseudonym with your local Better
  866. Bit Bureau (BBB).  At the moment the only better bit in town is at
  867. `http://www.cs.umn.edu/Research/GroupLens/bbb.html'.
  868.    Once you have registered you'll need to set a couple of variables.
  869. `gnus-use-grouplens'
  870.      Setting this variable to a non-`nil' value will make Gnus hook into
  871.      all the relevant GroupLens functions.
  872. `grouplens-pseudonym'
  873.      This variable should be set to the pseudonum you got when
  874.      registering with the Better Bit Bureau.
  875. `grouplens-newsgroups'
  876.      A list of groups that you want to get GroupLens predictions for.
  877.    Thats the minimum of what you need to get up and running with
  878. GroupLens.  Once you've registered, GroupLens will start giving you
  879. scores for articles based on the average of what other people think.
  880. But, to get the real benefit of GroupLens you need to start rating
  881. articles yourself.  Then the scores GroupLens gives you will be
  882. personalized for you, based on how the people you usually agree with
  883. have already rated.
  884. File: gnus,  Node: Rating Articles,  Next: Displaying Predictions,  Prev: Using GroupLens,  Up: GroupLens
  885. Rating Articles
  886. ---------------
  887.    In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
  888. Where 1 means something like this article is a waste of bandwidth and 5
  889. means that the article was really good.  The basic question to ask
  890. yourself is, "on a scale from 1 to 5 would I like to see more articles
  891. like this one?"
  892.    There are four ways to enter a rating for an article in GroupLens.
  893.      This function will prompt you for a rating on a scale of one to
  894.      five.
  895.      This function will prompt you for a rating, and rate all the
  896.      articles in the thread.  This is really useful for some of those
  897.      long running giant threads in rec.humor.
  898.    The next two commands, `n' and `,' take a numerical prefix to be the
  899. score of the article you're reading.
  900. `1-5 n'
  901.      Rate the article and go to the next unread article.
  902. `1-5 ,'
  903.      Rate the article and go to the next unread article with the
  904.      highest score.
  905.    If you want to give the current article a score of 4 and then go to
  906. the next article, just type `4 n'.
  907. File: gnus,  Node: Displaying Predictions,  Next: GroupLens Variables,  Prev: Rating Articles,  Up: GroupLens
  908. Displaying Predictions
  909. ----------------------
  910.    GroupLens makes a prediction for you about how much you will like a
  911. news article.  The predictions from GroupLens are on a scale from 1 to
  912. 5, where 1 is the worst and 5 is the best.  You can use the predictions
  913. from GroupLens in one of three ways controlled by the variable
  914. `gnus-grouplens-override-scoring'.
  915.    There are three ways to display predictions in grouplens.  You may
  916. choose to have the GroupLens scores contribute to, or override the
  917. regular gnus scoring mechanism. override is the default; however, some
  918. people prefer to see the Gnus scores plus the grouplens scores.  To get
  919. the separate scoring behavior you need to set
  920. `gnus-grouplens-override-scoring' to `'separate'.  To have the
  921. GroupLens predictions combined with the grouplens scores set it to
  922. `'override' and to combine the scores set
  923. `gnus-grouplens-override-scoring' to `'combine'.  When you use the
  924. combine option you will also want to set the values for
  925. `grouplens-prediction-offset' and `grouplens-score-scale-factor'.
  926.    In either case, GroupLens gives you a few choices for how you would
  927. like to see your predictions displayed.  The display of predictions is
  928. controlled by the `grouplens-prediction-display' variable.
  929.    The following are legal values for that variable.
  930. `prediction-spot'
  931.      The higher the prediction, the further to the right an `*' is
  932.      displayed.
  933. `confidence-interval'
  934.      A numeric confidence interval.
  935. `prediction-bar'
  936.      The higher the prediction, the longer the bar.
  937. `confidence-bar'
  938.      Numerical confidence.
  939. `confidence-spot'
  940.      The spot gets bigger with more confidence.
  941. `prediction-num'
  942.      Plain-old numeric value.
  943. `confidence-plus-minus'
  944.      Prediction +/i confidence.
  945. File: gnus,  Node: GroupLens Variables,  Prev: Displaying Predictions,  Up: GroupLens
  946. GroupLens Variables
  947. -------------------
  948. `gnus-summary-grouplens-line-format'
  949.      The summary line format used in summary buffers that are GroupLens
  950.      enhanced.  It accepts the same specs as the normal summary line
  951.      format (*note Summary Buffer Lines::.).  The default is
  952.      `%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n'.
  953. `grouplens-bbb-host'
  954.      Host running the bbbd server.  The default is
  955.      `grouplens.cs.umn.edu'.
  956. `grouplens-bbb-port'
  957.      Port of the host running the bbbd server.  The default is 9000.
  958. `grouplens-score-offset'
  959.      Offset the prediction by this value.  In other words, subtract the
  960.      prediction value by this number to arrive at the effective score.
  961.      The default is 0.
  962. `grouplens-score-scale-factor'
  963.      This variable allows the user to magnify the effect of GroupLens
  964.      scores.  The scale factor is applied after the offset.  The
  965.      default is 1.
  966. File: gnus,  Node: Various,  Next: The End,  Prev: Scoring,  Up: Top
  967. Various
  968. *******
  969. * Menu:
  970. * Process/Prefix::             A convention used by many treatment commands.
  971. * Interactive::                Making Gnus ask you many questions.
  972. * Formatting Variables::       You can specify what buffers should look like.
  973. * Windows Configuration::      Configuring the Gnus buffer windows.
  974. * Compilation::                How to speed Gnus up.
  975. * Mode Lines::                 Displaying information in the mode lines.
  976. * Highlighting and Menus::     Making buffers look all nice and cozy.
  977. * Buttons::                    Get tendonitis in ten easy steps!
  978. * Daemons::                    Gnus can do things behind your back.
  979. * NoCeM::                      How to avoid spam and other fatty foods.
  980. * Picons::                     How to display pictures of what your reading.
  981. * Various Various::            Things that are really various.
  982.